Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs overhaul #431

Open
wants to merge 16 commits into
base: dev
Choose a base branch
from
Open

Docs overhaul #431

wants to merge 16 commits into from

Conversation

dsweber2
Copy link
Contributor

@dsweber2 dsweber2 commented Jan 23, 2025

Checklist

Please:

  • Make sure this PR is against "dev", not "main".
  • Request a review from one of the current epipredict main reviewers:
    dajmcdon.
  • Make sure to bump the version number in DESCRIPTION and NEWS.md.
    Always increment the patch version number (the third number), unless you are
    making a release PR from dev to main, in which case increment the minor
    version number (the second number).
  • Describe changes made in NEWS.md, making sure breaking changes
    (backwards-incompatible changes to the documented interface) are noted.
    Collect the changes under the next release number (e.g. if you are on
    0.7.2, then write your changes under the 0.8 heading).
  • Consider pinning the epiprocess version in the DESCRIPTION file if
    • You anticipate breaking changes in epiprocess soon
    • You want to co-develop features in epipredict and epiprocess

Change explanations for reviewer

Draft ready for review:

  • Landing Page
  • Getting Started
  • Customized Forecasters
  • Reference
    • Using the add/update/remove and adjust functions
    • Smooth Quantile regression
  • preprocessing and models examples
  • backtesting forecasters

Magic GitHub syntax to mark associated Issue(s) as resolved when this is merged into the default branch

@dsweber2 dsweber2 requested a review from dajmcdon as a code owner January 23, 2025 20:59
@dajmcdon
Copy link
Contributor

/preview-docs

@dsweber2
Copy link
Contributor Author

/preview-docs

Copy link

github-actions bot commented Jan 23, 2025

@dshemetov
Copy link
Contributor

dshemetov commented Jan 23, 2025

Our setup is generating docs in dev/, so the link is off, this works:
https://6792d4953137ef0ce0547a4f--epipredict.netlify.app/dev/

Also FYI: the bot edits its own comment for links. Each preview is a separate link and the links stick around for like 90 days. You can see the previous links in the comment edit history.

Edit: this has been fixed on main so is no longer necessary

@dsweber2 dsweber2 force-pushed the docsDraft branch 4 times, most recently from 8044b98 to d35363e Compare January 27, 2025 22:50
@dsweber2
Copy link
Contributor Author

/preview-docs

@dsweber2
Copy link
Contributor Author

So something weird is happening with the plot for flatline_forecaster, not really sure why. Going to dig into that next.

I added an option to replace the data for the autoplot so you can compare with new data instead

@dsweber2
Copy link
Contributor Author

dsweber2 commented Feb 3, 2025

Draft of the getting started is ready, moving on to a draft of the "guts" page (name a placeholder), which is an overview of creating workflows by hand

@dsweber2
Copy link
Contributor Author

dsweber2 commented Feb 5, 2025

So something weird is happening with the plot for flatline_forecaster, not really sure why. Going to dig into that next.
image

After some digging, I don't think there are any bugs, just some edge-case behavior that we may not want:

  1. Thresholding and extrapolation don't interact well. In this case, the quantiles it fits are 0.05 and 0.95, and it correctly rounds the 5% quantile up to zero (b/c of the negative values it is actually negative w/out constraint). But, it also looks to plot the 2.5% and 97.5% quantiles, which extrapolate doesn't know should also be zero. This results in quantiles with negative values.
  2. The other thing is that the interpolated quantiles change quite a bit after thresholding if there's not very many quantiles. For example, the median gets pushed up quite a bit, but the point prediction doesn't reflect that.

My take away: never fit just the 5% and 95% quantiles. At least do the 50%. That fixes most of the jank this uncovers.

@dsweber2 dsweber2 self-assigned this Feb 7, 2025
@dsweber2
Copy link
Contributor Author

dsweber2 commented Feb 7, 2025

/preview-docs

@dshemetov
Copy link
Contributor

Including 0.5 into the user's selection sounds simple and reasonable to me. They can always filter out what they don't want.

@dsweber2
Copy link
Contributor Author

dsweber2 commented Feb 7, 2025

/preview-docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants